# 75. Django模板语言之变量

# 变量

在Django的模板语言中按此语法使用: 。

当模版引擎遇到一个变量,它将计算这个变量,然后用结果替换掉它本身。

# 变量的命名

  1. 包括任何字母数字以及下划线的组合。
  2. 变量名称中不能有空格或标点符号。

# 变量名中的 . 优先级

. 在模板语言中有特殊的含义。

当模版系统遇到点 . ,它将以这样的顺序查询:

  1. 字典查询(Dictionary lookup)
  2. 属性或方法查询(Attribute or method lookup)
  3. 数字索引查询(Numeric index lookup)

# 注意事项

  1. 如果计算结果的值是可调用的,它将被无参数的调用。 调用的结果将成为模版的值。
  2. 如果使用的变量不存在, 模版系统将插入 string_if_invalid 选项的值, 它被默认设置为'' (空字符串)

# 实例

def template_test(request):
    l = [11, 22, 33]
    d = {"name": "alex"}

    class Person(object):
        def __init__(self, name, age):
            self.name = name
            self.age = age

        def dream(self):
            return "{} is dream...".format(self.name)

    aaa = Person(name="aaa", age=34)
    bbb = Person(name="bbb", age=9000)
    ccc = Person(name="ccc", age=18)

    person_list = [aaa, bbb, ccc]
    return render(request, "template_test.html", {"l": l, "d": d, "person_list": person_list})


## 模板中支持的写法

{# 取l中的第一个参数 #}
{{ l.0 }}
{# 取字典中key的值 #}
{{ d.name }}
{# 取对象的name属性 #}
{{ person_list.0.name }}
{# .操作只能调用不带参数的方法 #}
{{ person_list.0.dream }}

# Filters(过滤器)

在Django的模板语言中,通过使用 过滤器 来改变变量的显示。

过滤器的语法:

{{ value|filter_name:参数 }}

使用管道符"|"来应用过滤器。

例如:以下会将name变量应用lower过滤器之后再显示它的值。lower在这里的作用是将文本全都变成小写。

{{ name|lower }}

注意事项:

  1. 过滤器支持“链式”操作。即一个过滤器的输出作为另一个过滤器的输入。
  2. 过滤器可以接受参数,例如:
{{ sss|truncatewords:30 }}

这将显示sss的前30个词,最多只是接收一个参数。 3. 过滤器参数包含空格的话,必须用引号包裹起来。比如使用逗号和空格去连接一个列表中的元素,如:

{{ list|join:', ' }}
  1. '|'左右没有空格没有空格没有空格

Django的模板语言中提供了大约六十个内置过滤器,这里只写常用的

# 常用的Filters过滤器

# default - 变量是false或者为空,就显示指定的值

如果一个变量是false或者为空,使用给定的默认值。 否则,使用变量的值。

{{ value|default:"nothing"}}

## 如果value没有传值或者值为空的话就显示nothing

# 增加系统默认选项

可以在项目中的settings.py文件中找到TEMPLATES列表中的OPTIONS字典中添加

'string_if_invalid':'找不到',前面的选项名是固定的,后面的字符串,是可自定的

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [os.path.join(BASE_DIR, 'templates')]
        ,
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
            'string_if_invalid':'找不到',
        },
    },
]

**注意:**通过这种方式写法,只支持变量名不存在或为false的情况下才会触发这个选项,这个选项的优先级要高过default

# add - 给变量加参数

给变量加参数

{{ value|add:"2" }}

{#
	value是数字4,则输出结果为6#}
{{ first|add:second }}

{#
	如果first是 [1,.2,3] ,second是 [4,5,6] ,那输出结果是 [1,2,3,4,5,6]#}

# length - 返回值的长度

返回值的长度,作用于字符串和列表。

{{ value|length }}

{#
返回value的长度,如 value=['a', 'b', 'c', 'd']的话,就显示4.
#}

# filesizeformat - 将获得的大小值转换成可读的格式

将值格式化为一个 “人类可读的” 文件尺寸 (例如 '13 KB', '4.1 MB', '102 bytes', 等等)。例如:

{{ value|filesizeformat }}

{# 如果 value 是 123456789,输出将会是 117.7 MB。 #}

# slice - 切片

{{value|slice:"2:-1"}}

# date - 时间格式化

将后端传递过来的日期数值格式化

now = datetime.datetime.now()
{{ now|date:"Y-m-d H:i:s"}}

**可用的参数 **

格式化字符 描述 示例输出
a 'a.m.''p.m.'(请注意,这与PHP的输出略有不同,因为这包括符合Associated Press风格的期间) 'a.m.'
A 'AM''PM' 'AM'
b 月,文字,3个字母,小写。 'jan'
B 未实现。
c ISO 8601格式。 (注意:与其他格式化程序不同,例如“Z”,“O”或“r”,如果值为naive datetime,则“c”格式化程序不会添加时区偏移量(请参阅datetime.tzinfo (opens new window)) 。 2008-01-02T10:30:00.000123+02:002008-01-02T10:30:00.000123如果datetime是天真的
d 月的日子,带前导零的2位数字。 '01''31'
D 一周中的文字,3个字母。 “星期五”
e 时区名称 可能是任何格式,或者可能返回一个空字符串,具体取决于datetime。 '''GMT''-500''US/Eastern'
E 月份,特定地区的替代表示通常用于长日期表示。 'listopada'(对于波兰语区域,而不是'Listopad'
f 时间,在12小时的小时和分钟内,如果它们为零,则分钟停留。 专有扩展。 '1''1:30'
F 月,文,长。 '一月'
g 小时,12小时格式,无前导零。 '1''12'
G 小时,24小时格式,无前导零。 '0''23'
h 小时,12小时格式。 '01''12'
H 小时,24小时格式。 '00''23'
i 分钟。 '00''59'
I 夏令时间,无论是否生效。 '1''0'
j 没有前导零的月份的日子。 '1''31'
l 星期几,文字长。 '星期五'
L 布尔值是否是一个闰年。 TrueFalse
m 月,2位数字带前导零。 '01''12'
M 月,文字,3个字母。 “扬”
n 月无前导零。 '1''12'
N 美联社风格的月份缩写。 专有扩展。 'Jan.''Feb.''March''May'
o ISO-8601周编号,对应于使用闰年的ISO-8601周数(W)。 对于更常见的年份格式,请参见Y。 '1999年'
O 与格林威治时间的差异在几小时内。 '+0200'
P 时间为12小时,分钟和'a.m。'/'p.m。',如果为零,分钟停留,特殊情况下的字符串“午夜”和“中午”。 专有扩展。 '1 am''1:30 pm' / t3>,'midnight','noon','12:30 pm'/ T10>
r RFC 5322 (opens new window)格式化日期。 'Thu, 21 Dec 2000 16:01:07 +0200'
s 秒,带前导零的2位数字。 '00''59'
S 一个月的英文序数后缀,2个字符。 'st''nd''rd''th'
t 给定月份的天数。 28 to 31
T 本机的时区。 'EST''MDT'
u 微秒。 000000 to 999999
U 自Unix Epoch以来的二分之一(1970年1月1日00:00:00 UTC)。
w 星期几,数字无前导零。 '0'(星期日)至'6'(星期六)
W ISO-8601周数,周数从星期一开始。 153
y 年份,2位数字。 '99'
Y 年,4位数。 '1999年'
z 一年中的日子 0365
Z 时区偏移量,单位为秒。 UTC以西时区的偏移量总是为负数,对于UTC以东时,它们总是为正。 -4320043200

# 可以在系统中增加配置

在系统中增加配置,这样就可以不用每次都写date的参数,只需要写date主体就行

## settings.py文件
USE_L10N = False
DATETIME_FORMAT = 'Y-m-d H:i:s'
DATE_FORMAT = 'Y-m-d'

# safe - 让django不要转意这个字符串

Django的模板中会对HTML标签和JS等语法标签进行自动转义,原因显而易见,这样是为了安全。但是有的时候我们可能不希望这些HTML元素被转义,比如我们做一个内容管理系统,后台添加的文章中是经过修饰的,这些修饰可能是通过一个类似于FCKeditor编辑加注了HTML修饰符的文本,如果自动转义的话显示的就是保护HTML标签的源文件。为了在Django中关闭HTML的自动转义有两种方式,如果是一个单独的变量我们可以通过过滤器“|safe”的方式告诉Django这段代码是安全的不必转义。

value = "<a href='#'>点我</a>"
{{ value|safe}}

{#
	让value中的a标签原样的输入在html上,可以在页面上正常使用访问
#}

# truncatechars - 截断指定长度的字符串-有省略号

如果字符串字符多于指定的字符数量,那么会被截断。截断的字符串将以可翻译的省略号序列(“...”)结尾。

{{ value|truncatechars:9}}

{#
	参数:截断的字符数
#}

# truncatewords - 截断指定长度的字符串-无省略号

在一定数量的字后截断字符串。

{{ value|truncatewords:9}}

{#
	参数:截断的字符数
#}

# cut - 移除变量中指定的字符

移除value中所有的与给出的变量相同的字符串

{{ value|cut:' ' }}

{#
	移除value中的所有空格
	如果value为'i love you',那么将输出'iloveyou'.
#}

# join - 字符串连接列表

使用字符串连接列表,例如Python的str.join(list)

{{ value|join:" // " }}

# timesince - 将日期格式设为自该日期起的时间

将日期格式设为自该日期起的时间(例如,“4天,6小时”)。

采用一个可选参数,它是一个包含用作比较点的日期的变量(不带参数,比较点为现在)。

例如,如果blog_date是表示2006年6月1日午夜的日期实例,并且comment_date是2006年6月1日08:00的日期实例,则以下将返回“8小时”:

{{ blog_date|timesince:comment_date }}

{#
	blog_date:是表示200661日午夜的日期实例
	comment_date:是20066108:00的日期实例
	则以下将返回“8小时”
	分钟是所使用的最小单位,对于相对于比较点的未来的任何日期,将返回“0分钟”。
#}

# timeuntil - 将日期格式设为自该日期起的时间

似于timesince,除了它测量从现在开始直到给定日期或日期时间的时间。

例如,如果今天是2006年6月1日,而conference_date是保留2006年6月29日的日期实例,则

{{ conference_date | timeuntil }}

将返回“4周”。

使用可选参数,它是一个包含用作比较点的日期(而不是现在)的变量。 如果from_date包含2006年6月22日,则以下内容将返回“1周”:

{{ conference_date|timeuntil:from_date }}

# divisibleby - 整除

{{ value|divisibleby:'2' }}

{#
	将value值跟指定的数,进行相除
		能整除返回true
		不能整除返回false
#}

# 其他常用的Filters过滤器

# first - 取第一个元素

取第一个元素

{{ value|first }}

# last - 最后一个元素

取最后一个元素

{{ value|last }}

# lower - 转换成小写

{{ value|lower }}

# upper - 转换成大写

{{ value|upper}}

# title - 标题

{{ value|title }}

# ljust - 左对齐

"{{ value|ljust:"10" }}"

# rjust - 右对齐

"{{ value|rjust:"10" }}"

# center - 居中

"{{ value|center:"15" }}"

# 自定义filter

# 1. 创建自定义filter代码文件存放目录

在子项目目录下创建templatetags目录,注意:

  1. 在子项目目录下,并不是在主项目目录下
  2. 创建的目录,名称为:templatetags,是固定的,不能自定义
  3. 创建的目录,是要Python目录包(package)

# 2. 创建自定义filter文件

在刚刚创建好的目录下,可以创建自定义名称的.py文件

## filter_app.py
from django import template
## 固定写法,生成一个注册实例对象
register = template.Library()


## 声明这个函数可以当成模板变量使用
@register.filter()
def cut(value, arg):
    """
    给任意指定的变量添加sb
    :param value: |左边被修饰的那个变量
    :return: 修饰后的变量内容
    """
    return value.replace(arg, "")


## 声明这个函数可以当成模板变量使用,name参数代表,使用指定的名称调用,如果没写,默认为函数名为调用名称
@register.filter(name="addSB") 
def add_sb(value):
    """
    给任意指定的变量添加sb
    :param value: |左边被修饰的那个变量
    :return: 修饰后的变量内容
    """
    return value + 'sb'

# 3. 使用自定义filter

在html文件中使用自定义filter,需要先导入这个文件

{# 先导入我们自定义filter那个文件 #}
{% load filter_app %}

{# 使用我们自定义的filter #}
{{ somevariable|cut:"0" }}
{{ d.name|addSB }}